home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 083 / phnxdoc.arc / PHNXDOC.3 < prev    next >
Text File  |  1987-12-04  |  20KB  |  462 lines
  1.  
  2.  
  3.       PHOENIX REMOTE COMMUNICATIONS SYSTEM                  DECEMBER 4, 1987
  4.  
  5.          3.0  PHOENIX FILES
  6.  
  7.              There are two types of files that comprise Phoenix and allow it
  8.              to function.
  9.  
  10.              The first type is SYSTEM FILES.  System Files are mandatory for
  11.              Phoenix's operation and MUST reside in your main Phoenix
  12.              directory or on the RAM disk from which you run Phoenix.  These
  13.              files are accessed frequently by Phoenix during program
  14.              operation.
  15.  
  16.              The second type is SUPPORT FILES.  Though these files are not
  17.              required to run Phoenix, we are sure you'll find them invaluable
  18.              in your operation.
  19.  
  20.  
  21.          3.1  SYSTEM FILES
  22.                 These are NOT optional and are NOT created by Phoenix
  23.  
  24.                     Phoenix.COM  -     Main System Program
  25.                     Phoenix.000  - 004 System Overlay Files
  26.                     MENU0.MNU   -     First menu user sees
  27.                     CONFIG.BBS  -     Created by running CONFIG
  28.                     DROP  .BAT  -     Used with Alt-D command
  29.  
  30.              NOTE:  Overlay files MUST be located in the Phoenix Root
  31.              Directory along with other System files.  Overlay files are used
  32.              to store Functions and Procedures which Phoenix can call at any
  33.              time.  They are not held in memory all the time and therefore
  34.              must be available for use.
  35.  
  36.          3.2  HELP FILES
  37.                optional and are not created by Phoenix
  38.  
  39.              You may edit these to fit your personal taste and to match
  40.              whatever commands you place in the menus. These files need
  41.              not remain named this way (see menu tutorial for further
  42.              information)
  43.  
  44.                     MAIN    .HLP  -  Main Menu Help File
  45.                     MMS     .HLP  -  Message Menu Help FIle
  46.                     FILES   .HLP  -  Files Menu Help File
  47.                     SYSOP   .HLP  -  Sysop Menu Help File
  48.  
  49.              You may edit the next two, but the file names cannot
  50.              be changed.
  51.  
  52.                     MSYSHELP.HLP  -  Message system configuration help
  53.                     FSYSHELP.HLP  -  Files system configuration help
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.       PHOENIX REMOTE COMMUNICATIONS SYSTEM                  DECEMBER 4, 1987
  69.  
  70.          3.3  MENU FILES - Phoenix Menu System Plus (tm)
  71.                   NOT created by Phoenix
  72.  
  73.                Only MENU0.MNU must exist for Phoenix to run and is NOT
  74.                optional. MENU1.MNU - MENU25.MNU are optional and are
  75.                created by you. We supply 4 menus with this version
  76.                of Phoenix to emulate the familiar v1.2 Collie system but
  77.                with some enhancements. This way, you
  78.                may get started with a minimum of effort and may
  79.                re-configure your menu system later.  This menu
  80.                system is, without a doubt, the MOST POWERFUL system
  81.                available!
  82.                See MENU TUTORIAL.
  83.  
  84.  
  85.          3.4  MESSAGE/USERS/AREA FILES
  86.                   NOT optional
  87.  
  88.              The following files are used as system files by Phoenix.  If
  89.              they are not found, Phoenix will create them.
  90.  
  91.                     MESSAGES.BBS  -  All messages are contained here.
  92.                     MESSAGES.PTR  -  Message pointers for scans, etc.
  93.                     USERS   .BBS  -  Users profile & statistics
  94.                     MSGINFO .SYS  -  Message area configurations
  95.                     FILEINFO.SYS  -  Files area configurations
  96.  
  97.          3.5  WELCOME FILES
  98.                   optional
  99.  
  100.              To create these files, you can use your favorite word processor,
  101.              EDLIN, or any of several programs designed to make Graphic
  102.              Welcome Screens.
  103.  
  104.              Even though these files are not mandatory, they give your board
  105.              originality. if a .* is used as the extension here, it means
  106.              that the file can have 2 extensions, .BBS or .CLR - the .bbs
  107.              extension file is expected to be text or upper IBM character
  108.              graphics. The .CLR extension tells Phoenix that this is an
  109.              ANSI GRAPHICS file. If .BBS only, it is expected to be
  110.              a text file. If a .CLR file is missing Phoenix will ALWAYS
  111.              look for the .bbs file.
  112.  
  113.                     PRELOG.BBS   - This screen is displayed before welcome1
  114.                                    and may contain pre-login announcements.
  115.  
  116.                     WELCOME1.*   - The screen displayed when callers first
  117.                                    connect before login.
  118.  
  119.                     ALL.*        - This file is displayed to all after
  120.                                    login but before welcome2.
  121.  
  122.                     WELCOME2.*   - The second screen displayed after your
  123.                                    caller logs-in.
  124.  
  125.                     NEWUSERS.BBS - Displayed to new users on their first
  126.                                    call. This is expected to be a text file.
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.       PHOENIX REMOTE COMMUNICATIONS SYSTEM                  DECEMBER 4, 1987
  135.  
  136.          3.6  BULLETIN FILES
  137.                    optional
  138.  
  139.              Bulletin files are designed the same way the welcome files are
  140.              created, using either EDLIN, a text editor or ansi editor.
  141.  
  142.                     BULLETIN.*   - Main Bulletin screen, lists the
  143.                                    available bulletins.
  144.  
  145.                     BULLxxxx.*   - Where x = 1 - 9999.  This number
  146.                                    should correspond to your bulletin
  147.                                    listed in BULLETIN.BBS. Note that all
  148.                                    bulletins must have an extension of
  149.                                    .bbs and optionally, .clr.
  150.                                    COLLIE 1.2 sysops take note of this
  151.                                    name change!
  152.  
  153.                     NOTE: If you are using ansi grafix you must call
  154.                           the files BULLETIN.CLR and BULLxxxx.CLR.
  155.                           To fully support all users, you should offer
  156.                           both sets of files. If a user has chosen ansi,
  157.                           and a .clr file is missing, Phoenix will use
  158.                           the .bbs file instead.
  159.  
  160.                     Choose whether you wish to send the bulletin menu
  161.                     to the user automatically at login or not within
  162.                     CONFIG.
  163.                     You may have optional user level sensitive bulletins
  164.                     using one of the optional menus. See menu tutorial.
  165.  
  166.  
  167.          3.7  USER INTERFACE FILES
  168.                   optional
  169.  
  170.              These files are used to help the sysop interface with
  171.              users in an efficient manner.
  172.  
  173.                   [seclevel].SEC - This special feature was added so the
  174.                                    sysop could send a special notice to
  175.                                    all users of a certain security level.
  176.                                    This file is not automatically erased.
  177.  
  178.                     [1..?]  .BBS - This special feature was added so theè
  179.                                    sysop could send a SPECIAL MESSAGE to an
  180.                                    individual user.
  181.  
  182.                                    Example: John Doe is User Record number
  183.                                    128 on your system.  If you have a file
  184.                                    called "128.BBS", Phoenix will dump
  185.                                    and erase this file right after
  186.                                    128.BBS is displayed the next time
  187.                                    John Doe calls.  Your callers log will
  188.                                    have a notation that the special
  189.                                    message was sent. This is a private file
  190.                                    displayed to the intended user only.
  191.  
  192.                     RESTRICT.BBS   This file is sent to a person who attempts
  193.                                    to log onto a restricted system. It
  194.                                    expects to be a text file.
  195.  
  196.  
  197.  
  198.  
  199.  
  200.       PHOENIX REMOTE COMMUNICATIONS SYSTEM                  DECEMBER 4, 1987
  201.  
  202.                     FILEMSG.*      This file is sent to a user only once
  203.                                    per login when he enters a menu defined
  204.                                    as a files menu (one which sends what
  205.                                    files area a user is in).
  206.  
  207.                     MSGMSG.*       This file is sent to a user only once
  208.                                    per login when he enters a menu defined
  209.                                    as a message menu (one which sends what
  210.                                    message board a user is in).
  211.  
  212.  
  213.                >    LIMITS  .BBS - If you would like to set different
  214.                                    DAILY time limits according to the
  215.                                    user's security level, you want to use
  216.                                    this file.
  217.  
  218.                                    The syntax is : Security Level, Daily
  219.                                    Time <RET>
  220.  
  221.                                    Example:
  222.  
  223.                                    5,10  {  5 Security, 10 Minutes/Day }
  224.                                    10,20 { 10 Security, 20 Minutes/Day }
  225.                                    25,30 { 25 Security, 30 Minutes/Day }
  226.  
  227.                                    See ADVANCED OPTIONS at the end of
  228.                                    the Phoenix documentation for additional
  229.                                    information on enhancements to this file.
  230.  
  231.  
  232.                     RATIO   .BBS - It's seldom (if ever), a caller's
  233.                                    uploads exceed his downloads.
  234.                                    That's par for the course.  However,
  235.                                    some users get in the habit of take,
  236.                                    take, take, and NEVER give a thought
  237.                                    to uploading.  This file works when the
  238.                                    warning ratio is set in Config. It wil
  239.                                    display your words of wisdom when this
  240.                                    situation presents itself. The user
  241.                                    will still be allowed to download.
  242.  
  243.                      LOCK  .BBS    This file is sent to a user who exceeds
  244.                                    the download/upload ratio set for
  245.                                    ratio.bbs and matches or exceeds the
  246.                                    ratio set to lock a caller's downloading
  247.                                    ability. Once this happens, the user will
  248.                                    be denied downloading ability. This is
  249.                                    done automatically when enabled within
  250.                                    Config.
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.       PHOENIX REMOTE COMMUNICATIONS SYSTEM                  DECEMBER 4, 1987
  267.  
  268.                  >  ALIAS  .BBS    ALIAS.BBS contains a list of all names
  269.                                    you don't want to allow on your board.
  270.                                    Names like: The, Hacker, Dr., Mr., PC,
  271.                                    Killer, All, Etc.
  272.                                    See ADVANCED OPTIONS for other
  273.                                    information about alias.bbs.
  274.                                    Phoenix reads this file line-by-line
  275.                                    and compares the names in the file
  276.                                    against the caller's first and last
  277.                                    name.
  278.  
  279.                    ALIAS2  .*      If a match is found, then
  280.                                    ALIAS2.BBS or ALIAS2.CLR is dumped
  281.                                    to the screen and
  282.                                    the caller is logged off!
  283.  
  284.  
  285.          3.8  OTHER SYSTEM FILES
  286.  
  287.              You may also add the following files to your system:
  288.  
  289.                     GOODBYE .*   - This file is displayed when a caller
  290.                                    logs off the system.
  291.  
  292.                >    FILES   .*   - Used in the File Sub-Directory for
  293.                                    listing files available for download in
  294.                                    that area. If you want to use files.clr,
  295.                                    you must create it otherwise, Phoenix will
  296.                                    use the .bbs file. If files.bbs does not
  297.                                    exist, Phoenix will create one. See
  298.                                    advanced uses and options for other
  299.                                    uses of files.*.
  300.  
  301.                     QUOTES  .BBS - Quote for the day for your callers
  302.                                    during log-on.  Phoenix indexes this
  303.                                    file, searching for a blank line
  304.                                    between each quote.
  305.  
  306.                     ALT-A   .BBS - ALT+A dumps this file to the screen, logs
  307.                                    the caller off, and LOCKS him out on
  308.                                    future calls.  Works great on problem
  309.                                    callers.
  310.  
  311.                     NO300   .BBS - Dumps this file to 300 baud callers, when
  312.                                    300 baud callers are not allowed.
  313.                                    Displayed only when enabled within
  314.                                    CONFIG.
  315.  
  316.                     P       .BAT - Batch file used to invoke Phoenix.
  317.                                    Also contains the necessary commands
  318.                                    for sysop's remote drop to DOS and
  319.                                    for executing events.
  320.  
  321.                     REMOTE  .BAT - Required if you want to drop to DOS
  322.                                    from remote on SOME systems. This file
  323.                                    is NOT required for most.
  324.  
  325.  
  326.                     F8      .BBS - This file is dumped to the screen when
  327.                                    you terminate a call.  Could say:
  328.                                    "Sorry, the sysop needs the computer!
  329.                                    Please call back later!"
  330.  
  331.  
  332.  
  333.       PHOENIX REMOTE COMMUNICATIONS SYSTEM                  DECEMBER 4, 1987
  334.  
  335.                     MAILER  .LOG - Contains all your Net-Mail activity.
  336.                                    The net mail system creates this file.
  337.  
  338.                     MODMINIT.BBS - This file is sent to "initialize your
  339.                                    modem" after each caller.  See Section
  340.                                    2.
  341.  
  342.                     PAGED   .*   - Displayed when a caller pages the
  343.                                    sysop, who either has the page feature
  344.                                    turned off, or simply doesn't answer
  345.                                    the page.  The file could contain your
  346.                                    office hours, or suggest that the
  347.                                    caller leave a message or comment.
  348.  
  349.                     ABOUTCOM.*   - Some sysops have special policies about
  350.                                    Comments to the Sysop. They can be made
  351.                                    known here. Even though comments are now
  352.                                    saved as messages in the message base,
  353.                                    some sysops may still prefer not to
  354.                                    reply to comments.
  355.  
  356.                                    This file can be displayed when a
  357.                                    caller selects the <C>omments command.
  358.  
  359.                        DROP.DOS -  This file should contain instructions
  360.                                    for the user how to return to Phoenix
  361.                                    when finished in DOS. If it does not
  362.                                    exist, Phoenix will default to a
  363.                                    standard message.
  364.  
  365.  
  366.          3.8a ABOUT DISPLAY FILES
  367.  
  368.              As you can see, Phoenix allows you complete flexibility when it
  369.              comes to displaying files.  The sysop has nearly total
  370.              flexibility in making his board as unique as he wants.
  371.  
  372.              There are a couple of features built into the display file
  373.              routines which give you even more control.  They are:
  374.                     CTRL-B - Toggles More Prompt.
  375.                     CTRL-C - Toggles the callers' ability to interrupt the
  376.                              display of the file.
  377.                     CTRL-D - At the top of the file, tells Phoenix to
  378.                              display "press <ENTER> to continue..."
  379.                              at the END of file. This is handy for files.*
  380.                              or [#].bbs, or anytime the last screen of the
  381.                              file is too short to invoke the <more> prompt
  382.                              and a menu would immediately scroll the info.
  383.                              This is not a toggle.
  384.                     CTRL-A - Tells Phoenix that this is an ANSI file even
  385.                              if it does not have a .clr extension. This
  386.                              is normally put at the top of the file, but
  387.                              can be placed anywhere and Phoenix will switch
  388.                              into ansi mode from that point till the end of
  389.                              the file. This is not a toggle.
  390.              Place these characters in your display file.  Remember with
  391.              toggles, when Phoenix sees the first one, it turns the
  392.              function OFF and leaves it OFF until it sees another toggle.
  393.              Phoenix defaults to Interrupt ON and Screen <M>ore Prompt ON.
  394.  
  395.  
  396.  
  397.  
  398.       PHOENIX REMOTE COMMUNICATIONS SYSTEM                  DECEMBER 4, 1987
  399.  
  400.          3.9  BACKUP FILES & CRITICAL LOGS
  401.  
  402.              When you perform sysop maintenance like Packing the Message Base
  403.              Users file, or system configuration files, Phoenix will first
  404.              make "Backup" copies for you.
  405.              You don't need to have these files in your
  406.              Phoenix root directory after they're made.  If space is a
  407.              problem on your board you could copy the backups to disk or
  408.              discard them.  They are:
  409.  
  410.                     MESSAGE.PBK    - Message Pointer Backup File
  411.  
  412.                     MESSAGE.TBK    - Message Base Backup File
  413.  
  414.                     USERS  .BAK    - Users Backup File
  415.  
  416.                     MSGINFO.BAK    - Message base configuration backup
  417.  
  418.                     FILEINFO.BAK   - Files area configuration backup
  419.  
  420.              Phoenix also keeps track of critical errors incurred during
  421.              program operation.  These are stored in a file called
  422.              "CRITICAL.LOG".
  423.  
  424.              If you're having problems running Phoenix, and you're sure
  425.              you've tried everything, report your version number and all the
  426.              information included in your CRITICAL.LOG file to any of the
  427.              boards listed in the 800 net (The GeneSys Project).  We'll do
  428.              everything possible to correct the problem or explain to you
  429.              why you're getting the errors!
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.